cisco-cvp-ux

Request

URL

http://[host]:[port]/cisco-cvp-ux/v1/{businessId}/resource

URI Parameter

Headers

Security Headers

Response

Possible success response

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

{
    "id": "000100000000040439",
    "@type": "PhysicalResource",
    "name": "IMEI Number",
    "resourceCharacteristic": [
        {
            "value": "500020",
            "name": "activationCode"
        }
    ],
    "resourceSpecification": {
        "id": "000000000000117052",
        "name": "MobileDeviceSKU",
        "@referredType": "PhysicalResourceSpecification"
    },
    "resourceRelationship": [
        {
            "relationshipType": "paried",
            "resource": {
                "id": "10345267",
                "name": "ICCID Number",
                "@type": "PhysicalResource",
                "resourceSpecification": {
                    "id": "000000000000117088",
                    "name": "SIMCardSKU",
                    "@referredType": "PhysicalResourceSpecification"
                }
            }
        }
    ]
}

Definitions

Possible response errors

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
    "errors": [
        {
            "code": 400,
            "message": "APIKIT:BAD_REQUEST",
            "description": "Invalid value 'M' for uri parameter businessId. M is not a valid enum value"
        }
    ]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }]
}

[ 403 ]

Forbidden - Indicates that the server understood the request but refuses to fulfill it. If authentication credentials were provided in the request, the server considers them insufficient to grant access. The client SHOULD NOT automatically repeat the request with the same credentials. The client MAY repeat the request with new or different credentials.

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
    "errors": [
        {
            "code": 404,
            "message": "APIKIT:NOT_FOUND",
            "description": "/PR/resource1"
        }
    ]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [
        {
            "code": 405,
            "message": "APIKIT:METHOD_NOT_ALLOWED",
            "description": "HTTP Method post not allowed for : /{businessId}/resource"
        }
    ]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
"errors" : [{
"code" : 500,
"message" : "The request failed due to an internal error.",
"description": "error description"
}]
}

[ 501 ]

Check for the other BU Flows, if not implemented then throw a standard error message as below.

{
    "errors": [
        {
            "code": 501,
            "message": "NOT IMPLEMENTED",
            "description": "Operation GET /{businessId}/resource for Business Id: PA not implemented."
        }
    ]
}

[ 503 ]

Service Unavailable

    {
    "errors": [
        {
            "code": 503,
            "message": "HTTP:SERVICE_UNAVAILABLE",
            "description": "HTTP GET on resource 'http://0.0.0.0:9091//tmf-api/resource-inventory-management-biz/v1/{businessId}/resource' failed: service unavailable (503)."
        }
    ]
}